STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/sdcde-dataelement
Sets expectations for data elements exchanged or maintained within data element registries according to requirements established by the structured data capture project
This profile was published on Mon, Apr 21, 2014 00:00+1000 as a draft by Health Level Seven International (Orders and Observations - Structured Data Capture).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DataElement.
Summary
Mandatory: 15 elements (+7 nested mandatory elements)
Must-Support: 80 elements
Fixed Value: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from DataElement.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DataElement | I | 0..* | DataElement | Resource data element inv-2: One and only one DataElement.code must have is-data-element-concept set to "true" |
 meta | ∑ | 0..1 | Meta | Metadata about the resource |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 11179-de-effective-period | S | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
| 11179-de-document-reference | S | 0..1 | Reference(DocumentReference) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference |
| 11179-de-administrative-status | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status |
| 11179-de-change-description | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description |
| 11179-de-submitter-org | S | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org |
| 11179-de-registry-org | S | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 1..1 | uri | Globally unique logical id for data element |
 identifier | S ∑ | 1..1 | Identifier | Logical id to reference this data element |
| version | S ∑ | 1..1 | string | Logical id for this version of the data element |
| status | ?! S∑ | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
| experimental | S ∑ | 0..1 | boolean | If for testing purposes, not real usage |
| publisher | S ∑ | 1..1 | string | Name of the publisher (Organization or individual) |
| date | S ∑ | 0..1 | dateTime | Date for this version of the data element |
| name | S ∑ | 1..1 | string | Descriptive label for this element definition |
| contact | S ∑ | 1..* | BackboneElement | Contact details of the publisher |
 11179-de-contact-address | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| name | S ∑ | 1..1 | string | Name of an individual to contact |
 telecom | S ∑ | 1..1 | ContactPoint | Contact details for individual or publisher |
| useContext | S ∑ | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| 11179-de-classification-or-context | S | 1..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context |
| coding | ∑ | 0..* | Coding | Code defined by a terminology system |
| text | ∑ | 0..1 | string | Plain text representation of the concept |
| copyright | S | 0..1 | string | Use and/or publishing restrictions |
| stringency | S ∑ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementStringency (required) Fixed Value: comparable |
 mapping | BackboneElement | External specification mapped to Slice: Unordered, Open, by uri | ||
| mapping | S | 1..1 | BackboneElement | External specification mapped to |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| identity | S | 1..1 | id | Internal id when this mapping is used Fixed Value: objclass-prop |
| uri | S | 1..1 | uri | Identifies what this mapping refers to Fixed Value: http://healthit.gov/sdc/objectclassproperty |
| name | S | 0..1 | string | Names what this mapping refers to |
| comment | S | 0..1 | string | Versions, Issues, Scope limitations etc. |
| mapping | S I | 0..* | BackboneElement | External specification mapped to inv-1: Property extension can only be specified if ObjectClass extension is present |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| identity | S | 1..1 | id | Internal id when this mapping is used |
| uri | S | 0..1 | uri | Identifies what this mapping refers to |
| name | S | 0..1 | string | Names what this mapping refers to |
| comment | S | 0..1 | string | Versions, Issues, Scope limitations etc. |
| element | S ∑I | 1..* | ElementDefinition | Definition of element dae-1: No base allowed dae-2: No slicing allowed |
 elementdefinition-question | S | 2..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question |
| elementdefinition-allowedUnits | S | 0..* | CodeableConcept, Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| path | S ∑ | 1..1 | string | The path of the element (see the Detailed Descriptions) |
| representation | ∑ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText Binding: PropertyRepresentation (required) |
| name | S ∑ | 0..1 | string | Name for this particular element definition (reference target) |
| label | S ∑ | 0..1 | string | Name for element to display with or prompt for element |
| code | S ∑ | 0..* | Coding | Defining code Binding: DataElement SDC Concept (extensible) |
| 11179-de-is-data-element-concept | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept | |
| system | ∑ | 0..1 | uri | Identity of the terminology system |
| version | ∑ | 0..1 | string | Version of the system - if relevant |
| code | ∑ | 0..1 | code | Symbol in syntax defined by the system |
| display | ∑ | 0..1 | string | Representation defined by the system |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
| slicing | ∑ I | 0..1 | Element | This element is sliced - slices follow eld-1: If there are no discriminators, there must be a definition |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| discriminator | ∑ | 0..* | string | Element values that are used to distinguish the slices |
| description | ∑ I | 0..1 | string | Text description of how slicing works (or not) |
| ordered | ∑ | 0..1 | boolean | If elements must be in same order as slices |
| rules | ∑ | 1..1 | code | closed | open | openAtEnd Binding: SlicingRules (required) |
| short | ∑ | 0..1 | string | Concise definition for xml presentation |
| definition | S ∑ | 1..1 | markdown | Full formal definition as narrative text |
| comments | ∑ | 0..1 | markdown | Comments about the use of this element |
| requirements | S ∑ | 0..1 | markdown | Why this resource has been created |
| alias | S ∑ | 0..* | string | Other names |
| min | S ∑I | 0..1 | integer | Minimum Cardinality |
| max | S ∑I | 0..1 | string | Maximum Cardinality (a number or *) eld-3: Max SHALL be a number or "*" |
| base | ∑ | 0..1 | Element | Base definition information for tools |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| path | ∑ | 1..1 | string | Path that identifies the base element |
| min | ∑ | 1..1 | integer | Min cardinality of the base element |
| max | ∑ | 1..1 | string | Max cardinality of the base element |
| contentReference | ∑ I | 0..1 | uri | Reference to definition of content for the element |
| type | S ∑I | 0..1 | Element | Data type and Profile for this element eld-4: Aggregation may only be specified if one of the allowed types for the element is a resource |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| code | S ∑ | 1..1 | code | Name of Data type or Resource Binding: FHIRDefinedType (required) |
| profile | ∑ | 0..* | uri | Profile (StructureDefinition) to apply (or IG) |
| aggregation | ∑ I | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required) |
| versioning | ∑ | 0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required) |
 defaultValue[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Specified value if missing from instance |
| meaningWhenMissing | ∑ I | 0..1 | markdown | Implicit meaning when this element is missing |
| fixed[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Value must be exactly this |
| pattern[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Value must have at least these property values |
| example[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Example value (as defined for type) |
| minValue[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Minimum Allowed Value (for some types) |
| maxValue[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Maximum Allowed Value (for some types) |
| maxLength | S ∑ | 0..1 | integer | Max length for strings |
| condition | S ∑ | 0..* | id | Reference to invariant about presence |
| constraint | S ∑ | 0..* | Element | Condition that must evaluate to true |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| key | S ∑I | 1..1 | id | Target of 'condition' reference above |
| requirements | S ∑ | 0..1 | string | Why this constraint is necessary or appropriate |
| severity | S ∑ | 1..1 | code | error | warning Binding: ConstraintSeverity (required) |
| human | S ∑ | 1..1 | string | Human description of constraint |
| expression | ∑ | 0..1 | string | FluentPath expression of constraint |
| xpath | S ∑ | 1..1 | string | XPath expression of constraint |
| isModifier | ∑ | 0..1 | boolean | If this modifies the meaning of other elements |
| isSummary | ∑ | 0..1 | boolean | Include when _summary = true? |
| binding | S ∑I | 0..1 | Element | ValueSet details if this is coded eld-10: provide either a reference or a description (or both) |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| strength | S ∑ | 1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required) |
| description | S ∑I | 0..1 | string | Human explanation of the value set |
 valueSetReference | S ∑I | 1..1 | Reference(Structured Data Capture Data Element Exchange Value Set) | Source of value set eld-12: URI SHALL start with http:// or https:// urn: inv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present |
| 11179-permitted-value-valueset | S | 0..1 | Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset |
| 11179-permitted-value-conceptmap | S | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap |
| reference | ∑ I | 0..1 | string | Relative, internal or absolute URL reference |
| display | ∑ | 0..1 | string | Text alternative for the resource |
| mapping | ∑ | Element | Map element to another set of definitions Slice: Unordered, Open, by identity | |
| mapping | S ∑ | 0..1 | Element | Map element to another set of definitions |
| 11179-objectClass | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClass" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| 11179-objectClassProperty | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| identity | S ∑ | 1..1 | id | Reference to mapping declaration Fixed Value: objclass-prop |
| language | ∑ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | S ∑ | 1..1 | string | Details of the mapping |
| mapping | S ∑ | 0..* | Element | Map element to another set of definitions |
| elementdefinition-equivalence | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence |
| identity | S ∑ | 1..1 | id | Reference to mapping declaration |
| language | S ∑ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | S ∑ | 1..1 | string | Details of the mapping |
| Documentation for this format | ||||
todo
This structure is derived from DataElement.
Summary
Mandatory: 15 elements (+7 nested mandatory elements)
Must-Support: 80 elements
Fixed Value: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DataElement.
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataElement | I | 0..* | DataElement | Resource data element inv-2: One and only one DataElement.code must have is-data-element-concept set to "true" |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| 11179-de-effective-period | S | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
| 11179-de-document-reference | S | 0..1 | Reference(DocumentReference) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference |
| 11179-de-administrative-status | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status |
| 11179-de-change-description | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description |
| 11179-de-submitter-org | S | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org |
| 11179-de-registry-org | S | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 1..1 | uri | Globally unique logical id for data element |
| identifier | S ∑ | 1..1 | Identifier | Logical id to reference this data element |
| version | S ∑ | 1..1 | string | Logical id for this version of the data element |
| status | ?! S∑ | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
| experimental | S ∑ | 0..1 | boolean | If for testing purposes, not real usage |
| publisher | S ∑ | 1..1 | string | Name of the publisher (Organization or individual) |
| date | S ∑ | 0..1 | dateTime | Date for this version of the data element |
| name | S ∑ | 1..1 | string | Descriptive label for this element definition |
| contact | S ∑ | 1..* | BackboneElement | Contact details of the publisher |
| 11179-de-contact-address | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| name | S ∑ | 1..1 | string | Name of an individual to contact |
| telecom | S ∑ | 1..1 | ContactPoint | Contact details for individual or publisher |
| useContext | S ∑ | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| 11179-de-classification-or-context | S | 1..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context |
| coding | ∑ | 0..* | Coding | Code defined by a terminology system |
| text | ∑ | 0..1 | string | Plain text representation of the concept |
| copyright | S | 0..1 | string | Use and/or publishing restrictions |
| stringency | S ∑ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementStringency (required) Fixed Value: comparable |
| mapping | BackboneElement | External specification mapped to Slice: Unordered, Open, by uri | ||
| mapping | S | 1..1 | BackboneElement | External specification mapped to |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| identity | S | 1..1 | id | Internal id when this mapping is used Fixed Value: objclass-prop |
| uri | S | 1..1 | uri | Identifies what this mapping refers to Fixed Value: http://healthit.gov/sdc/objectclassproperty |
| name | S | 0..1 | string | Names what this mapping refers to |
| comment | S | 0..1 | string | Versions, Issues, Scope limitations etc. |
| mapping | S I | 0..* | BackboneElement | External specification mapped to inv-1: Property extension can only be specified if ObjectClass extension is present |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| identity | S | 1..1 | id | Internal id when this mapping is used |
| uri | S | 0..1 | uri | Identifies what this mapping refers to |
| name | S | 0..1 | string | Names what this mapping refers to |
| comment | S | 0..1 | string | Versions, Issues, Scope limitations etc. |
| element | S ∑I | 1..* | ElementDefinition | Definition of element dae-1: No base allowed dae-2: No slicing allowed |
| elementdefinition-question | S | 2..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question |
| elementdefinition-allowedUnits | S | 0..* | CodeableConcept, Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| path | S ∑ | 1..1 | string | The path of the element (see the Detailed Descriptions) |
| representation | ∑ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText Binding: PropertyRepresentation (required) |
| name | S ∑ | 0..1 | string | Name for this particular element definition (reference target) |
| label | S ∑ | 0..1 | string | Name for element to display with or prompt for element |
| code | S ∑ | 0..* | Coding | Defining code Binding: DataElement SDC Concept (extensible) |
| 11179-de-is-data-element-concept | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept | |
| system | ∑ | 0..1 | uri | Identity of the terminology system |
| version | ∑ | 0..1 | string | Version of the system - if relevant |
| code | ∑ | 0..1 | code | Symbol in syntax defined by the system |
| display | ∑ | 0..1 | string | Representation defined by the system |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
| slicing | ∑ I | 0..1 | Element | This element is sliced - slices follow eld-1: If there are no discriminators, there must be a definition |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| discriminator | ∑ | 0..* | string | Element values that are used to distinguish the slices |
| description | ∑ I | 0..1 | string | Text description of how slicing works (or not) |
| ordered | ∑ | 0..1 | boolean | If elements must be in same order as slices |
| rules | ∑ | 1..1 | code | closed | open | openAtEnd Binding: SlicingRules (required) |
| short | ∑ | 0..1 | string | Concise definition for xml presentation |
| definition | S ∑ | 1..1 | markdown | Full formal definition as narrative text |
| comments | ∑ | 0..1 | markdown | Comments about the use of this element |
| requirements | S ∑ | 0..1 | markdown | Why this resource has been created |
| alias | S ∑ | 0..* | string | Other names |
| min | S ∑I | 0..1 | integer | Minimum Cardinality |
| max | S ∑I | 0..1 | string | Maximum Cardinality (a number or *) eld-3: Max SHALL be a number or "*" |
| base | ∑ | 0..1 | Element | Base definition information for tools |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| path | ∑ | 1..1 | string | Path that identifies the base element |
| min | ∑ | 1..1 | integer | Min cardinality of the base element |
| max | ∑ | 1..1 | string | Max cardinality of the base element |
| contentReference | ∑ I | 0..1 | uri | Reference to definition of content for the element |
| type | S ∑I | 0..1 | Element | Data type and Profile for this element eld-4: Aggregation may only be specified if one of the allowed types for the element is a resource |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| code | S ∑ | 1..1 | code | Name of Data type or Resource Binding: FHIRDefinedType (required) |
| profile | ∑ | 0..* | uri | Profile (StructureDefinition) to apply (or IG) |
| aggregation | ∑ I | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required) |
| versioning | ∑ | 0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required) |
| defaultValue[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Specified value if missing from instance |
| meaningWhenMissing | ∑ I | 0..1 | markdown | Implicit meaning when this element is missing |
| fixed[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Value must be exactly this |
| pattern[x] | ∑ I | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Value must have at least these property values |
| example[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Example value (as defined for type) |
| minValue[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Minimum Allowed Value (for some types) |
| maxValue[x] | S ∑ | 0..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Meta | Maximum Allowed Value (for some types) |
| maxLength | S ∑ | 0..1 | integer | Max length for strings |
| condition | S ∑ | 0..* | id | Reference to invariant about presence |
| constraint | S ∑ | 0..* | Element | Condition that must evaluate to true |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| key | S ∑I | 1..1 | id | Target of 'condition' reference above |
| requirements | S ∑ | 0..1 | string | Why this constraint is necessary or appropriate |
| severity | S ∑ | 1..1 | code | error | warning Binding: ConstraintSeverity (required) |
| human | S ∑ | 1..1 | string | Human description of constraint |
| expression | ∑ | 0..1 | string | FluentPath expression of constraint |
| xpath | S ∑ | 1..1 | string | XPath expression of constraint |
| isModifier | ∑ | 0..1 | boolean | If this modifies the meaning of other elements |
| isSummary | ∑ | 0..1 | boolean | Include when _summary = true? |
| binding | S ∑I | 0..1 | Element | ValueSet details if this is coded eld-10: provide either a reference or a description (or both) |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| strength | S ∑ | 1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required) |
| description | S ∑I | 0..1 | string | Human explanation of the value set |
| valueSetReference | S ∑I | 1..1 | Reference(Structured Data Capture Data Element Exchange Value Set) | Source of value set eld-12: URI SHALL start with http:// or https:// urn: inv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present |
| 11179-permitted-value-valueset | S | 0..1 | Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset |
| 11179-permitted-value-conceptmap | S | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap |
| reference | ∑ I | 0..1 | string | Relative, internal or absolute URL reference |
| display | ∑ | 0..1 | string | Text alternative for the resource |
| mapping | ∑ | Element | Map element to another set of definitions Slice: Unordered, Open, by identity | |
| mapping | S ∑ | 0..1 | Element | Map element to another set of definitions |
| 11179-objectClass | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClass" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| 11179-objectClassProperty | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| identity | S ∑ | 1..1 | id | Reference to mapping declaration Fixed Value: objclass-prop |
| language | ∑ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | S ∑ | 1..1 | string | Details of the mapping |
| mapping | S ∑ | 0..* | Element | Map element to another set of definitions |
| elementdefinition-equivalence | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence |
| identity | S ∑ | 1..1 | id | Reference to mapping declaration |
| language | S ∑ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | S ∑ | 1..1 | string | Details of the mapping |
| Documentation for this format | ||||
XML Template
JSON Template
todo
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| DataElement.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| DataElement.status | ConformanceResourceStatus | required | ConformanceResourceStatus |
| DataElement.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
| DataElement.stringency | DataElementStringency | required | DataElementStringency |
| DataElement.element.representation | PropertyRepresentation | required | PropertyRepresentation |
| DataElement.element.code | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.slicing.rules | SlicingRules | required | SlicingRules |
| DataElement.element.type.code | FHIRDefinedType | required | FHIRDefinedType |
| DataElement.element.type.aggregation | AggregationMode | required | AggregationMode |
| DataElement.element.type.versioning | ReferenceVersionRules | required | ReferenceVersionRules |
| DataElement.element.constraint.severity | ConstraintSeverity | required | ConstraintSeverity |
| DataElement.element.binding.strength | BindingStrength | required | BindingStrength |
| DataElement.element.mapping.extension.valueCoding | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.mapping.extension.valueCoding | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.mapping.language | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| DataElement.element.mapping.language | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Id | Path | Details | Requirements |
| inv-2 | DataElement | One and only one DataElement.code must have is-data-element-concept set to "true" XPath: count(f:code/f:extension[@uri='http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept'])=1 | |
| inv-1 | DataElement.mapping | Property extension can only be specified if ObjectClass extension is present XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property'])) | |
| inv-1 | DataElement.mapping | Property extension can only be specified if ObjectClass extension is present XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property'])) | |
| inv-1 | DataElement.mapping | Property extension can only be specified if ObjectClass extension is present XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property'])) | |
| dae-1 | DataElement.element | No base allowed XPath: not(exists(f:base)) | |
| dae-2 | DataElement.element | No slicing allowed XPath: not(exists(f:slicing)) | |
| eld-1 | DataElement.element.slicing | If there are no discriminators, there must be a definition XPath: (f:discriminator) or (f:description) | |
| eld-3 | DataElement.element.max | Max SHALL be a number or "*" XPath: @value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))='') | |
| eld-4 | DataElement.element.type | Aggregation may only be specified if one of the allowed types for the element is a resource XPath: not(exists(f:aggregation)) or exists(f:code[@value = 'Reference']) | |
| eld-10 | DataElement.element.binding | provide either a reference or a description (or both) XPath: (exists(f:valueSetUri) or exists(f:valueSetReference)) or exists(f:description) | |
| eld-12 | DataElement.element.binding.valueSetReference | URI SHALL start with http:// or https:// urn: XPath: starts-with(string(@value), 'http:') or starts-with(string(@value), 'https:') or starts-with(string(@value), 'urn:') | |
| inv-3 | DataElement.element.binding.valueSetReference | Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present XPath: count(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset'])=count(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap']) |
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:10+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change
